Package com.seclore.fs.ws.client.pscp
Interface LoginHandler
public interface LoginHandler
This interface provides methods to ping, authenticate and logout session with the Server.
-
Method Summary
Modifier and TypeMethodDescriptionThis method returns the Enterprise Application ID.voidgetSessionKey(PSConnection pPSConnection) This methods sends get session key requestvoidlogin(PSConnection pPSConnection) This method sends request to authenticate a session.voidlogout(PSConnection pPSConnection) This function logs the user out.ping(PSConnection pPSConnection) This function checks whether server is up or not and returns response header.
-
Method Details
-
login
This method sends request to authenticate a session. It should throw an exception in case of any error. No error will be thrown if the authentication is successful.- Parameters:
pPSConnection- The PSConnection instance used to send the request to Policy Server.- Throws:
PSCPException- The PSCPException instance in case of error while login.
-
logout
This function logs the user out. This is used while terminating connections.- Parameters:
pPSConnection- The PSConnection instance used to send the request to Policy Server.- Throws:
PSCPException- The PSCPException instance in case of error while logout.
-
ping
This function checks whether server is up or not and returns response header.- Parameters:
pPSConnection- The PSConnection object.- Returns:
- The HttpResponseInfo instance in case of success.
- Throws:
PSCPException- The PSCPException instance in case of error while ping.
-
getEnterpriseApplicationID
String getEnterpriseApplicationID()This method returns the Enterprise Application ID.- Returns:
-
getSessionKey
void getSessionKey(PSConnection pPSConnection) throws com.seclore.fs.helper.exception.FSHelperException This methods sends get session key request- Parameters:
pPSConnection-- Throws:
com.seclore.fs.helper.exception.FSHelperException
-